de.cebis.moccabox.io
Interface IODefinition

All Superinterfaces:

IModelSource, ITaskCommandCollection, java.io.Serializable

All Known Implementing Classes:

StandardIODefinition

public interface IODefinition
extends ITaskCommandCollection, IModelSource, java.io.Serializable

Interface, das den Aufruf eines Anwenders (IClient) über den gesamten Lebenszyklus des IO spezifiziert. Die IODefinition dient als Grundlage für die Interpretation des IO als Präsentation für den Nutzer (z.B. in HTML oder PDF).

Author:

weichelt - 21.01.2005

Field Summary

static java.lang.String

SESSION_KEY Referenz auf die IODefinition.

Fields inherited from interface de.cebis.moccabox.model.IModelSource

FIELD_MODEL

Method Summary

void	addMessage(Message message) Hinzufügen einer Meldung, die dem IO mitgegeben werden soll.
IClient	getClient() Zurückliefern des Anwenders (maschinell oder personell), der das IO abgesendet hat.
Message[]	getMessages() Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.
ModelNode	getModel() Zurückliefern des ModelNode, der dem Aufruf zu Grunde liegt.
java.lang.String	getState() Zurückliefern des aktuellen Zustands des Vorgangs der mit dem IO korrespondiert.
TaskCommand	getTaskCommand() Zurückliefern des Kommandos, das das IO ausgelöst hat.
TaskCommandContainer	getTaskCommandContainer() Zurückliefern des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.
Message[]	readMessages() Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.
void	setClient(IClient client) Setzen des Anwenders (maschinell oder personell), der das IO abgesendet hat.
void	setModel(ModelNode model) Setzen des ModelNode, der dem Aufruf zu Grunde liegt.
void	setState(java.lang.String state) Setzen des Zustands des korrespondierenden Vorgangs.
void	setTaskCommand(TaskCommand command) Setzen des Kommandos, das das IO ausgelöst hat.
void	setTaskCommandContainer(TaskCommandContainer commands) Setzen des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.

Methods inherited from interface de.cebis.moccabox.io.command.ITaskCommandCollection

retrieveTaskCommands

Field Detail

SESSION_KEY

static final java.lang.String SESSION_KEY

Referenz auf die IODefinition.

See Also:

Constant Field Values

Method Detail

setModel

void setModel(ModelNode model)

Setzen des ModelNode, der dem Aufruf zu Grunde liegt.

Parameters:

model - Die Abstraktion der Anwendung aus Sicht der IO-Schicht.

getModel

ModelNode getModel()

Zurückliefern des ModelNode, der dem Aufruf zu Grunde liegt. Der ModelNode stellt im Sinne des MVC-Modells (Model-View-Controller) das Model dar und wird vom GUI-Framework für die interaktive Ausgabe an den Anwender interpretiert.

Specified by:

getModel in interface IModelSource

Returns:

Die Abstraktion der Anwendung aus Sicht der IO-Schicht.

setClient

void setClient(IClient client)

Setzen des Anwenders (maschinell oder personell), der das IO abgesendet hat.

Parameters:

client - Der beauftragende Client.

getClient

IClient getClient()

Zurückliefern des Anwenders (maschinell oder personell), der das IO abgesendet hat.

Returns:

Der beauftragende Client.

setTaskCommand

void setTaskCommand(TaskCommand command)

Setzen des Kommandos, das das IO ausgelöst hat.

Parameters:

command - Das abgesetzte Kommando.

getTaskCommand

TaskCommand getTaskCommand()

Zurückliefern des Kommandos, das das IO ausgelöst hat.

Returns:

Das abgesetzte Kommando.

setTaskCommandContainer

void setTaskCommandContainer(TaskCommandContainer commands)

Setzen des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet.

Parameters:

commands - Behälter aller verfügbarer TaskCommand-Objekte.

getTaskCommandContainer

TaskCommandContainer getTaskCommandContainer()

Zurückliefern des Containers, der alle verfügbaren TaskCommand-Objekte beinhaltet. Die Kommandos sind im Behälter zusammengefasst, da sie encoded werden, bevor sie dargestellt werden können. Vor allem für die Verwendung mit dem HTT-Protokoll ist es wichtig, dass in einem GET die Kommandos nicht in Klartext dargestellt werden, da das zu Manipulationen führen kann. Jedes Kommando wird daher durch ein entsprechendes Ticket repräsentiert, das auch nur eine bestimmte Gültigkeitsdauer hat. Sobald es aufgerufen wurde, wird es invalidiert und kann nicht per copy & paste wiederverwendet werden.

Returns:

Behälter aller verfügbarer TaskCommand-Objekte.

addMessage

void addMessage(Message message)

Hinzufügen einer Meldung, die dem IO mitgegeben werden soll.

Parameters:

message - Neue Meldung.

getMessages

Message[] getMessages()

Zurückliefern aller Meldungen, die dem IO mitgegeben wurden.

Returns:

Alle Meldungen des IO.

readMessages

Message[] readMessages()

Zurückliefern aller Meldungen, die dem IO mitgegeben wurden. Die Meldungen werden dabei auch gelöscht, so dass sie nach dem Auslesen nicht nochmals angezeigt werden können.

Returns:

Alle Meldungen des IO.

setState

void setState(java.lang.String state)

Setzen des Zustands des korrespondierenden Vorgangs.

Parameters:

state - Zustand des Vorgangs.

getState

java.lang.String getState()

Zurückliefern des aktuellen Zustands des Vorgangs der mit dem IO korrespondiert. Je nachdem, welchen State der Vorgang eingenommen hat, gilt er als unterbrochen, erfolgreich beendet oder mit Fehler abgebrochen.

Returns:

Zustand des Vorgangs.
STATE_INSTANTIATED
STATE_INPUT
STATE_FINISHED_WITH_ERRORS
STATE_FINISHED_WITH_SUCCESS
STATE_FINISHED_INCOMPLETE
STATE_FAILED
STATE_WAITING_FOR_CONFIRMATION